/*
 * Copyright 2008 - 2009 Lars Heuer (heuer[at]semagia.com). All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.semagia.atomico.server.storage;

/**
 * Represents <tt>order by</tt> constants for {@link IStorage}.
 * <p>
 * The <tt>SortOrder</tt> should be unimportant for machines but maybe helpful
 * for humans.
 * </p>
 * 
 * @author Lars Heuer (heuer[at]semagia.com) <a href="http://www.semagia.com/">Semagia</a>
 */
public enum SortOrder {

    /**
     * Indicates no special ordering at all.
     */
    ANY,

    /**
     * Indicates that the titles are ordered ascending.
     */
    TITLE_ASC,

    /**
     * Indicates that the titles are ordered desceneding.
     */
    TITLE_DESC,

    /**
     * Indicates that the updated time should be ordered ascending.
     */
    UPDATED_ASC,

    /**
     * Indicates that updated time should be ordered desceneding.
     */
    UPDATED_DESC

}
